Carbon


PlotCIconHandle

Header: Icons.h Carbon status: Supported

Draws an icon of resource type 'cicn' to which you have a handle.

OSErr PlotCIconHandle (
    const Rect *theRect, 
    IconAlignmentType align, 
    IconTransformType transform, 
    CIconHandle theCIcon
);
theRect

A pointer to the rectangle in which to draw the icon, specified in local coordinates of the current graphics port.

align

Specifies how the function should align the icon within the rectangle. See “Alignment Type Values” for a description of the values you can use in this parameter.

transform

Specifies how the function should modify the appearance of the icon. See “Transform Type Values” for a description of the values you can use in this parameter.

theCIcon

A handle to the color icon structure of the icon to draw. You can obtain a handle to the icon using the GetCIcon function or GetResource or other Resource Manager functions.

function result

A result code.

DISCUSSION

Unlike PlotCIcon, this function doesn’t honor the current foreground and background colors.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)